Class CepInstanceImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.CepInstanceImpl
All Implemented Interfaces:
IPCObject, CepInstance
Direct Known Subclasses:
ScriptModuleImpl

public class CepInstanceImpl extends IPCObjectImpl implements CepInstance
Information provided by the PKI file:

    \class CepInstance
    
    \brief      CepInstance is the external process (ExApp and Script Module) that communicates with Packet Tracer through the IPC.
    
    \example ipcManager().thisInstance()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getInstanceId

      public UUID getInstanceId()
      Information provided by the PKI file:
      
          \brief Returns the UUID of this external process.
          
          \return uuid, the UUID of this external process.
          
              
      Specified by:
      getInstanceId in interface CepInstance
      Returns:
      UUID Returns a UUID
    • getCep

      public Cep getCep()
      Specified by:
      getCep in interface CepInstance
      Returns:
      Cep Returns a Cep
    • addExclusivePublisher

      public boolean addExclusivePublisher(String pem)
      Information provided by the PKI file:
      
          \brief Returns true if the exclusive publisher with the specified certificate was added successfully, otherwise false.
          
          \param pem, the PEM base64-encoded DER certificate string.
          
          \return bool, true if the exclusive publisher with the specified certificate was added successfully, otherwise false.
          
              
      Specified by:
      addExclusivePublisher in interface CepInstance
      Parameters:
      pem - Takes in a parameter of pem
      Returns:
      boolean Returns a boolean
    • clearExclusivePublishers

      public void clearExclusivePublishers()
      Information provided by the PKI file:
      
          \brief Clears all exclusive publishers.
          
              
      Specified by:
      clearExclusivePublishers in interface CepInstance
    • removeExclusivePublisher

      public boolean removeExclusivePublisher(String pem)
      Information provided by the PKI file:
      
          \brief Returns true if the exclusive publisher with the specified certificate was removed successfully, otherwise false.
          
          \param pem, the PEM base64-encoded DER certificate string.
          
          \return bool, true if the exclusive publisher with the specified certificate was removed successfully, otherwise false.
          
              
      Specified by:
      removeExclusivePublisher in interface CepInstance
      Parameters:
      pem - Takes in a parameter of pem
      Returns:
      boolean Returns a boolean
    • removeExclusivePublisherAt

      public void removeExclusivePublisherAt(int index)
      Information provided by the PKI file:
      
          \brief Removes the exclusive publisher at the specified index.
          
          \param index, the index of the exclusive publisher.
          
              
      Specified by:
      removeExclusivePublisherAt in interface CepInstance
      Parameters:
      index - Takes in a parameter of index
    • getExclusivePublisherCount

      public int getExclusivePublisherCount()
      Information provided by the PKI file:
      
          \brief Returns the number of exclusive publishers.
          
          \return int, the number of exclusive publishers.
          
              
      Specified by:
      getExclusivePublisherCount in interface CepInstance
      Returns:
      int Returns a int
    • getExclusivePublisherAt

      public String getExclusivePublisherAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the exclusive publisher at the specified index.
          
          \param index, the index of the exclusive publisher.
          
          \return string, the exclusive publisher at the specified index.
          
              
      Specified by:
      getExclusivePublisherAt in interface CepInstance
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • hasExclusivePublisher

      public boolean hasExclusivePublisher(String pem)
      Information provided by the PKI file:
      
          \brief Returns true if the specified certificate is an exclusive publisher, otherwise false.
          
          \param pem, the PEM base64-encoded DER certificate string.
          
          \return bool, Returns true if the specified certificate is an exclusive publisher, otherwise false.
          
              
      Specified by:
      hasExclusivePublisher in interface CepInstance
      Parameters:
      pem - Takes in a parameter of pem
      Returns:
      boolean Returns a boolean
    • getCommandLineArg

      public String getCommandLineArg()
      Information provided by the PKI file:
      
          \brief Returns the command line argument for this external process (ExApp or Script Module) when launching PT.
          
          \return QString, the command line argument fort his external process
          
              
      Specified by:
      getCommandLineArg in interface CepInstance
      Returns:
      String Returns a String